-
-
Notifications
You must be signed in to change notification settings - Fork 198
feat: add TsconfigPathsPlugin #463
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #463 +/- ##
==========================================
+ Coverage 93.13% 93.49% +0.36%
==========================================
Files 45 48 +3
Lines 2155 2305 +150
Branches 654 691 +37
==========================================
+ Hits 2007 2155 +148
- Misses 119 122 +3
+ Partials 29 28 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
3a9a876
to
9243884
Compare
lib/TsconfigPathsPlugin.js
Outdated
? this.configFile | ||
: resolver.join(process.cwd(), this.configFile); | ||
|
||
const mainOptions = await this.readTsconfigCompilerOptions( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can cache readTsconfigCompilerOptions
using (and the same for readTsconfigCompilerOptions
below)
this.tsconfigProcessorCache = new WeakMap<TS_CONFIG_JSON_VALUE, { aliases: Aliases, references: References }>;
So we will read everything only on the first run, and will keep results until GC allow it
Feel free to think how we can avoid more tasks on the second and third calls
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What if we just store the data on this.tsconfigPathsData?
It doesn’t need to be garbage-collected anyway, so the cache implementation doesn’t have to be too complex.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added comments, also let's add test cases, good start for this plugin, thank you
This comment was marked as outdated.
This comment was marked as outdated.
b1a6c4e
to
f45b2f3
Compare
6af0057
to
49820ff
Compare
4362983
to
50aa0ca
Compare
lib/TsconfigPathsUtils.js
Outdated
if ( | ||
!exists && | ||
extendedConfigValue.includes("/") && | ||
extendedConfigValue.includes(".") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you describe these checks? Maybe we can just check if exist?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The goal here is to resolve the extendedConfigValue path from node_modules, e.g. extends: "react/tsconfig". Reference: https://github.com/jonaskello/tsconfig-paths/blob/master/src/tsconfig-loader.ts#L187
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lib/TsconfigPathsUtils.js
Outdated
if (!compilerOptions) return null; | ||
|
||
return { | ||
...tsconfigPathsToResolveOptions( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can cache this, look at ExportsFieldPlugin.js
plugin, we have this.fieldProcessorCache
to cache processed export fields, so let's use the same logic, just using this.tsconfigProcessorCache
name and cache result of this function
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The tsconfigPathsToResolveOptions
function only runs once per resolve. However, the key of this.fieldProcessorCache
is JsonObject
(ExportsFieldPlugin.fieldProcessorCache: WeakMap<JsonObject, FieldProcessor>
), and since each resolve produces a different JsonObject
reference, this cache becomes ineffective in scenarios where it should run only once per resolve. This makes me wonder whether the cache in ExportsFieldPlugin
(this.fieldProcessorCache
) aligns with the original intent—perhaps the key should be a string
rather than an object
reference.
Add let's add more test cases to improve coverage |
No description provided.